Swagger Integration #240

LeaveNhA · 2022-10-19T14:15:46Z

Title: Swagger Integration

Description

In this PR, simply aimed to implement the Swagger Integration in Xiana-way. I'm fully open to critics

Tester info

The tests are so naive, so let me write more tests.

Completion Checklist

Nothing, now.

g-krisztian · 2022-10-25T14:11:51Z

src/xiana/swagger.clj

+  (-> routes
+      helpers/routes->routes'
+      ((if (not (false? render?))
+         #(helpers/routes->swagger-data % :route-opt-map route-opt-map)
+         identity))
+      ((cond
+         (= type :json) json/write-value-as-string
+         (= type :edn) identity
+         :else identity))))


https://clojuredocs.org/clojure.core/as-%3E

That's not what I was meant to write actually. If you don't have any strong opinions, I would rather go with this way on that.

g-krisztian · 2022-10-25T14:12:18Z

src/xiana/swagger.clj

+             type :type
+             route-opt-map :route-opt-map}]
+  (if (swagger-configs-there? config)
+    (let [routes (or routes (-> config :routes))


Why the macro?

Fixed with more accurate version, get.

g-krisztian · 2022-10-25T14:14:30Z

src/xiana/swagger.clj

+          config-key (-> config
+                         (get :xiana/swagger {})
+                         (get :path :swagger.json))]


Suggested change

config-key (-> config

(get :xiana/swagger {})

(get :path :swagger.json))]

config-key (get-in config [:xiana/swagger :path] :swagger.json)]

That was helpful but evantually, it will grow like this because of the potential of the BL.
Also, fixed, for now.

g-krisztian · 2022-10-25T14:22:15Z

src/xiana/swagger.clj

+  (->> config
+       ((juxt :xiana/swagger-ui :xiana/swagger))
+       (reduce #(and % %2) true)
+       boolean))


(apply and ((juxt :xiana/swagger-ui :xiana/swagger) config))

or

(every? some? ((juxt :xiana/swagger-ui :xiana/swagger) config))

(apply and ((juxt :xiana/swagger-ui :xiana/swagger) config)) is the right reflection of that s-expression without overseeing any future changes. Fixed, thanks.

Also, throwing an exception due to and is a macro. Going with the second option for a while. Thanks.

g-krisztian · 2022-10-25T14:25:33Z

src/xiana/route/helpers.clj

@@ -16,3 +23,73 @@
          (assoc :error e)
          (assoc :response
                 {:status 500 :body "Internal Server error"})))))
+
+(defonce all-methods


It should be part of xiana.swagger ns, isn't it?

I was seeing the future again, and experimenting with more advanced and growth code-base. So, for now, fixed.

src/xiana/route/helpers.clj

g-krisztian · 2022-10-25T14:31:55Z

I'd like to see the default swagger endpoints added to the app routes on route initialization at https://github.com/Flexiana/framework/blob/main/src/xiana/route.clj#L11 when the swagger feature is enabled in configuration.

LeaveNhA · 2022-10-25T16:48:46Z

I'd like to see the default swagger endpoints added to the app routes on route initialization at https://github.com/Flexiana/framework/blob/main/src/xiana/route.clj#L11 when the swagger feature is enabled in configuration.

I was thinking on that too, but you are still ignoring the people who might want to configure or tweak their enpoints. I think we can give them some configuration options by our configuration system but if you think carefully there is still some things that we can't configure with this way. For now, we provide basic functionality also, less configuration. Let me finish and push it. So we can examine it.

Edit: your point is adding them silently, only by configuration, I believe. It seems not right to me. I would love to hear different perspectives over it, first.

src/xiana/swagger.clj

Removing unwanted, development s-expressions from the PR.

Co-authored-by: Gustavo Valente <gustavo.valente@flexiana.com>

LeaveNhA requested review from agigao, g-krisztian, narocath and soulflyer October 25, 2022 12:39

g-krisztian reviewed Oct 25, 2022

View reviewed changes

src/xiana/route/helpers.clj Outdated Show resolved Hide resolved

LeaveNhA self-assigned this Oct 27, 2022

LeaveNhA requested a review from g-krisztian October 28, 2022 10:02

LeaveNhA mentioned this pull request Nov 4, 2022

Swagger integration #208

Closed

soulflyer suggested changes Nov 25, 2022

View reviewed changes

src/xiana/swagger.clj Outdated Show resolved Hide resolved

gmsvalente requested a review from soulflyer September 29, 2023 21:37

LeaveNhA added 13 commits September 29, 2023 19:34

Implementing the helpers of Swagger Data generation.

f1d0212

Implementing the core functionality of swagger data generetion.

aa01c18

Writing base tests for swagger data generation.

1704915

Clearing the test file from dev expressions.

b185a5f

Fix on json sym -> keyw

4cc1ac6

Add Swagger config keys.

9b8a981

Update and re-factor Swagger implementation.

79631b6

Fix styling with a new-line.

81b407a

Improve functionality with arbitrary compilation map of routes.

8985777

Kondo fixes.

c0c2f6d

Fix on Styling.

fd94310

Fix over render? flag.

f380b25

Removing the logic from it since it's not the right place now.

95650c9

LeaveNhA and others added 15 commits September 29, 2023 19:35

Formatted internally.

e7fc386

Update swagger.clj

2e24cd5

Removing unwanted, development s-expressions from the PR.

Changes from re-factoring session with Core team.

d5075f4

Fixing the re-factored function usage.

7343fe7

Fix bugs WIP

5719018

Refactor nonsense code

f6f8e60

Clean ->swagger-data function

b17e9f8

Clean routes->swagger-data function

fff1388

Refactor routes->swagger-data

1318c6e

Add new docstrings

15d65f9

Fix clj-kondo

79f91ba

Move swagger tests to proper namespace

0b90796

Fix code to pass tests

06579a2

Remove unused namespace

0d74665

Change functions name and refactor code

7d2f9db

gmsvalente force-pushed the dev/swagger-integration branch from ece3066 to 7d2f9db Compare October 5, 2023 17:27

gmsvalente and others added 7 commits October 6, 2023 08:42

Cleanup swagger.json response function

b7a79eb

cleanup names

69a32a3

Fix swagger

b9366dc

Apply cljstyle to tests

7aff810

Apply cljstyle to route_test

12b4c1c

Add missing reitit.swagger namespace

44af66d

Update Readme

891f658

Co-authored-by: Gustavo Valente <gustavo.valente@flexiana.com>

soulflyer approved these changes Oct 20, 2023

View reviewed changes

soulflyer requested review from agigao and g-krisztian and removed request for agigao, narocath and g-krisztian October 20, 2023 11:40

soulflyer merged commit 080d0e2 into main Oct 24, 2023
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger Integration #240

Swagger Integration #240

LeaveNhA commented Oct 19, 2022

g-krisztian Oct 25, 2022

LeaveNhA Oct 25, 2022

g-krisztian Oct 25, 2022

LeaveNhA Oct 25, 2022

g-krisztian Oct 25, 2022

LeaveNhA Oct 25, 2022

g-krisztian Oct 25, 2022 •

edited

LeaveNhA Oct 25, 2022

LeaveNhA Oct 25, 2022

g-krisztian Oct 25, 2022

LeaveNhA Oct 25, 2022

g-krisztian commented Oct 25, 2022

LeaveNhA commented Oct 25, 2022 •

edited

Swagger Integration #240

Swagger Integration #240

Conversation

LeaveNhA commented Oct 19, 2022

Title: Swagger Integration

Description

Tester info

Completion Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

g-krisztian Oct 25, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

g-krisztian commented Oct 25, 2022

LeaveNhA commented Oct 25, 2022 • edited

g-krisztian Oct 25, 2022 •

edited

LeaveNhA commented Oct 25, 2022 •

edited